home *** CD-ROM | disk | FTP | other *** search
/ PC Gamer (Italian) 35 / PC Gamer IT CD 35 1-2.iso / Elink / NSCOMM / CNTTOOL.JS < prev    next >
Text File  |  1997-10-22  |  12KB  |  371 lines
  1. /* ==================================================================
  2. FILE:   CntTool.js
  3. DESCR:  Contents control library file for Netscape Help implementation.
  4. NOTES:  Requires Utility.js
  5. ================================================================== */
  6. var ASSERT = true
  7.  
  8. var contentsObj
  9.  
  10. var aDatasets      = new Array()
  11. var aTmpContainers = new Array()
  12. var aTmpItems      = new Array()
  13.  
  14. /*
  15. DESCR:   Contents class.
  16. PARAMS:  bgcolor  Background color for the Contents tool.
  17. RETURNS: 
  18. NOTES:   
  19. */
  20. function contents( bgcolor )
  21. {
  22.    //top.SystemFrame.trace( "contents construct" )
  23.    //alert( "contents construct" )
  24.  
  25.    this.bgcolor = bgcolor
  26.  
  27.    this.lastToggledContainerIndex
  28.  
  29.    this.bContainerToggle = false
  30.    this.bItemSelected    = false
  31.    this.currentDataset   = ""
  32.  
  33.    this.setDataset     = setDataset
  34.    this.updateTree     = updateTree
  35.    this.updateEntries  = updateEntries
  36.    this.writeDocument  = writeDocument
  37.    this.scrollDocument = scrollDocument
  38.    this.containerClick = containerClick
  39.    this.itemClick      = itemClick
  40.  
  41.    // Set global reference to this component.
  42.    contentsObj = this
  43.  
  44.    // Load data.
  45.    loadData()
  46. }
  47.  
  48.    /*
  49.    DESCR:   Selects a dataset for the tool.
  50.    PARAMS:  indexName  The name that indexes the dataset in the
  51.                        datasets array.
  52.    RETURNS: 
  53.    NOTES:   
  54.    */
  55.    function setDataset( indexName )
  56.    {
  57.       //alert( "setDataset, " + indexName )
  58.       //top.SystemFrame.trace( "contents setDataset()" )
  59.  
  60.       this.currentDataset = indexName
  61.    }
  62.  
  63.    /*
  64.    DESCR:   Updates the Contents tree.
  65.    PARAMS:  newURL  The current topic. Passing a URL expands its container
  66.             as needed and selects the item representing the URL. If updating
  67.             to just to toggle a container, pass null.
  68.    RETURNS: 
  69.    NOTES:   
  70.    */
  71.    function updateTree( newURL )
  72.    {
  73.       //top.SystemFrame.trace( "contents updateTree()" )
  74.       //alert( "updateTree" )
  75.  
  76.       assert( ( this.currentDataset != "" ), DATASET )
  77.  
  78.       // Write a background color to the hidden frame, and bind its events to
  79.       // the global handlers.
  80.       frames[ 0 ].document.open()
  81.       var html = "<BODY BGCOLOR = " + this.bgcolor + ">"
  82.       html += "<SCRIPT LANGUAGE = 'JavaScript1.2'>"
  83.       html += "top.bindDocEvts( document )"
  84.       html += "</SCRIPT></BODY>"
  85.       frames[ 0 ].document.write( html )
  86.       frames[ 0 ].document.close()
  87.  
  88.       // Bind hidden frame events to global event handlers.
  89.       top.bindDocEvts( frames[ 0 ].document )
  90.  
  91.       // Determine if this is an update just to toggle a container.
  92.       this.bContainerToggle = ( ( typeof( newURL ) == "undefined" ) ? true : false )
  93.  
  94.       // Update the entry objects.
  95.       if ( !this.bContainerToggle ) this.updateEntries( newURL )
  96.  
  97.       // Write the tree.
  98.       this.writeDocument()
  99.  
  100.       // Bind event handlers.
  101.       top.bindDocEvts( ContentsFrame.document )
  102.  
  103.       // Scroll the tree.
  104.       if ( this.bItemSelected ) this.scrollDocument()
  105.    }
  106.  
  107.    /*
  108.    DESCR:   Updates the tree entry objects.
  109.    PARAMS:  newURL  The URL from updateTree().
  110.    RETURNS: 
  111.    NOTES:  
  112.    */
  113.    function updateEntries( newURL )
  114.    {
  115.       //top.SystemFrame.trace( "contents updateEntries()" )
  116.       //alert("updateEntries()")
  117.  
  118.       var aTmpContainers = aDatasets[ this.currentDataset ]
  119.  
  120.       // Check each item...
  121.       var itemsSelected = 0  // Assert only.
  122.       this.bItemSelected = false
  123.       for ( var i = 0; i < aTmpContainers.length; i++ ) {
  124.          for ( var j = 0; j < aTmpContainers[ i ].aItems.length; j++ ) {
  125.             with ( aTmpContainers[ i ].aItems[ j ] ) {
  126.                
  127.                // ...and turn off any that are selected...
  128.                if ( bSelected ) bSelected = false
  129.  
  130.                // ...and select the specified item...
  131.                if ( URLsSansPathsAreSame( URL, newURL ) ) {
  132.  
  133.                   itemsSelected++
  134.                   assert( ( itemsSelected < 2 ), ITEMS_SELECTED )
  135.  
  136.                   bSelected = true
  137.                   this.bItemSelected = true
  138.  
  139.                   // ...making sure the selected item's container is expanded.
  140.                   aTmpContainers[ i ].bExpanded = true
  141.                }
  142.             }
  143.          }
  144.       }
  145.    }
  146.  
  147.    /*
  148.    DESCR:   Scrolls the tree.
  149.    PARAMS:  
  150.    RETURNS: 
  151.    NOTES:   If update is triggered outside of tool, we want to scroll as
  152.             needed to the selected item to show where user is in the tree.
  153.             Same for an item click, so the item is visible. For a container
  154.             click, we only want to scroll to the clicked container, since
  155.             the user is just looking for, or covering up, items.
  156.    */
  157.    function scrollDocument()
  158.    {
  159.       //top.SystemFrame.trace( "contents scrollDocument()" )
  160.       //alert("scrollDocument")
  161.  
  162.       // Ignore scrolling if content does not exceed window.
  163.       if ( frames[ 1 ].document.height < frames[ 1 ].innerHeight ) return
  164.  
  165.       // Calculate our best guess of pixel magnitude along the y axis of tree
  166.       // window for the item we want to make visible.
  167.       var aTmpContainers  = aDatasets[ this.currentDataset ]
  168.       var y               = 0
  169.       var containerHeight = 11
  170.       var itemHeight      = 11
  171.       var topMargin       = 4
  172.       var bottomMargin    = 4
  173.       var wrapLeading     = 4
  174.       var charPerLine     = 14
  175.             
  176.       // Tally pixels for entries.
  177.       for ( var i = 0; i < aTmpContainers.length; i++ ) {
  178.  
  179.          // Tally for the container. Tally must account for how
  180.          // many lines the entry takes up, including the spacing between
  181.          // lines that wrap.
  182.          var lines = Math.ceil( aTmpContainers[ i ].text.length / charPerLine )
  183.          y += topMargin +
  184.               ( containerHeight * lines ) +
  185.               ( wrapLeading * ( lines - 1 ) ) +
  186.               bottomMargin
  187.  
  188.          // If just toggling a container, tally only to the newly
  189.          // toggled container.
  190.          if ( this.bContainerToggle && this.lastToggledContainerIndex == i ) {
  191.             break
  192.          }
  193.  
  194.          // Tally items in opened containers.
  195.          if ( aTmpContainers[ i ].bExpanded ) {
  196.             for ( var j = 0; j < aTmpContainers[ i ].aItems.length; j++ ) {
  197.                
  198.                // Tally for the item.
  199.                var tmpItemLength = aTmpContainers[ i ].aItems[ j ].text.length
  200.                lines = Math.ceil( tmpItemLength / charPerLine )
  201.                y += topMargin +
  202.                     ( itemHeight * lines ) +
  203.                     ( wrapLeading * ( lines - 1 ) ) +
  204.                     bottomMargin
  205.  
  206.                // If updating for a newly selected item, stop all tallying
  207.                // when we get to the selected item.
  208.                if ( !this.bContainerToggle &&
  209.                     aTmpContainers[ i ].aItems[ j ].bSelected ) {
  210.                   i = ( aTmpContainers.length )
  211.                   break
  212.                }
  213.             }
  214.          }
  215.       }
  216.  
  217.       // Scroll to bring the entry to the middle of the window.
  218.       var frameHeight = frames[ 1 ].innerHeight
  219.       var center = ( frameHeight / 2 )
  220.       if ( y > center ) frames[ 1 ].scrollTo( 0, y - center )
  221.    }
  222.  
  223.    /*
  224.    DESCR:   Writes the tree document.
  225.    PARAMS:  
  226.    RETURNS: 
  227.    NOTES:   
  228.    */
  229.    function writeDocument()
  230.    {
  231.       //top.SystemFrame.trace( "contents writeDocument()" )
  232.       //alert("writeDocument")
  233.  
  234.       var aTmpContainers = aDatasets[ this.currentDataset ]
  235.  
  236.       var link
  237.       var html = "<HTML><HEAD>"
  238.  
  239.       html += "<STYLE TYPE = 'text/javascript'>"
  240.  
  241.       html += "classes.container.a.fontFamily = 'arial';"
  242.       html += "classes.container.a.fontSize = '12px';"
  243.       html += "classes.container.a.marginTop = 4;"
  244.       html += "classes.container.a.marginBottom = 4;"
  245.       //html += "classes.container.a.textDecoration = 'none';"
  246.  
  247.       html += "classes.unselectedItem.a.fontFamily = 'arial';"
  248.       html += "classes.unselectedItem.a.fontSize = '12px';"
  249.       html += "classes.unselectedItem.a.marginLeft = 4;"
  250.       html += "classes.unselectedItem.a.marginTop = 4;"
  251.       html += "classes.unselectedItem.a.marginBottom = 4;"
  252.       html += "classes.unselectedItem.a.color = '#6600ff';"
  253.  
  254.       html += "classes.selectedItem.a.fontFamily = 'arial';"
  255.       html += "classes.selectedItem.a.fontSize = '12px';"
  256.       html += "classes.selectedItem.a.marginLeft = 4;"
  257.       html += "classes.selectedItem.a.marginTop = 4;"
  258.       html += "classes.selectedItem.a.marginBottom = 4;"
  259.       html += "classes.selectedItem.a.color = '#6600ff';"
  260.       html += "classes.selectedItem.a.fontWeight = 'bold';"
  261.       //html += "classes.selectedItem.a.backgroundColor = 'white';"
  262.  
  263.       // Remove href underlining.
  264.       html += "tags.a.textDecoration = 'none';"
  265.  
  266.       html += "</STYLE>"
  267.  
  268.       html += "</HEAD><BODY BGCOLOR = " + this.bgcolor +
  269.               " LINK = '#000066' ALINK = '#000066' VLINK = '#000066'>"
  270.  
  271.       for ( var i = 0; i < aTmpContainers.length; i++ ) {
  272.  
  273.          link = "\"javascript:parent.contentsObj.containerClick('" + this.currentDataset + "', " + i + ")\""
  274.          html += "<A CLASS = 'container' HREF = " + link + ">" + aTmpContainers[ i ].text + "</A>"
  275.  
  276.          if ( aTmpContainers[ i ].bExpanded ) {
  277.             for ( var j = 0; j < aTmpContainers[ i ].aItems.length; j++ ) {
  278.                with ( aTmpContainers[ i ].aItems[ j ] ) {
  279.  
  280.                   var ssClass = ( bSelected ? "selectedItem" : "unselectedItem" )
  281.                   link = "\"javascript:parent.contentsObj.itemClick('" + this.currentDataset + "', " + i + ", " + j + ")\""
  282.                   html += "<A CLASS = '" + ssClass + "' HREF = " + link + ">" + text + "</A>"
  283.                }
  284.             }
  285.          }
  286.       }
  287.  
  288.       html += "</BODY></HTML>"
  289.  
  290.       with ( frames[ 1 ].document ) {
  291.          open()
  292.          write( html )
  293.          close()
  294.       }
  295.    }
  296.  
  297.    /*
  298.    DESCR:   Container object click "event."
  299.    PARAMS:  datasetIndex    The dataset index.
  300.             containerIndex  The container index.
  301.    RETURNS: 
  302.    NOTES:   
  303.    */
  304.    function containerClick( datasetIndex, containerIndex )
  305.    {
  306.       // Toggle the container's state.
  307.       var obj = aDatasets[ datasetIndex ][ containerIndex ]
  308.       obj.bExpanded = ( obj.bExpanded ? false : true )
  309.       this.lastToggledContainerIndex = containerIndex
  310.             
  311.       // Update the tree.
  312.       this.updateTree()
  313.    }
  314.  
  315.    
  316.    /*
  317.    DESCR:   Item object click "event."
  318.    PARAMS:  datasetIndex    The dataset index.
  319.             containerIndex  The container index.
  320.             itemIndex       The item index.
  321.    RETURNS: 
  322.    NOTES:   
  323.    */
  324.    function itemClick( datasetIndex, containerIndex, itemIndex )
  325.    {
  326.       // Notify component owner of selection, and update tree on success.
  327.       var obj = aDatasets[ datasetIndex ][ containerIndex ].aItems[ itemIndex ]
  328.       
  329.       // Load the topic (location doesn't matter since it's a nethelp URL.
  330.       location = obj.netHelpURL
  331.    }
  332.  
  333.  
  334. // End class definition: contents.
  335.  
  336. /*
  337. DESCR:   Container class.
  338. PARAMS:  text    The container's text.
  339.          aItems  Array of item objects.
  340. RETURNS: 
  341. NOTES:   
  342. */
  343. function container( text, aItems )
  344. {
  345.    this.text     = text
  346.    this.aItems   = aItems
  347.  
  348.    this.bExpanded = false
  349. }
  350.  
  351. // End class definition: container.
  352.  
  353. /*
  354. DESCR:   Item class.
  355. PARAMS:  text        The item's text.
  356.          URL         The URL in non-NetHelp form.
  357.          netHelpURL  The URL in NetHelp form.
  358. RETURNS: 
  359. NOTES:   
  360. */
  361. function item( text, URL, netHelpURL )
  362. {
  363.    this.text       = text
  364.    this.URL        = URL
  365.    this.netHelpURL = netHelpURL
  366.  
  367.    this.bSelected = false
  368. }
  369.  
  370. // End class definition: item.
  371.